package cn.lzy.study.ratelimiter.annotation;

import cn.lzy.study.ratelimiter.enums.LimiterType;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 限流注解
 * @author LZY
 * @since 2022-08-16
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface RateLimiter {

    /**
     * 限流的key，主要指前缀
     * @return
     */
    String key() default "rate_limiter:";

    /**
     * 限流时间窗(单位：秒)
     * @return
     */
    int time() default 60;

    /**
     * 在时间窗内的限流次数
     * @return
     */
    int count() default 100;

    /**
     * 限流类型
     * @return
     */
    LimiterType limiterType() default LimiterType.DEFAULT;
}
